<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: Trace ISR APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.10.3</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__trace__isr__apis.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Trace ISR APIs<div class="ingroups"><a class="el" href="group__trace__recorder__apis.html">Trace Recorder APIs</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga00c946394372405d80af6ea398ccf18e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__isr__apis.html#ga00c946394372405d80af6ea398ccf18e">xTraceISRGetCurrentNesting</a>(puiValue)&#160;&#160;&#160;TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puiValue) = pxTraceISRData-&gt;cores[TRC_CFG_GET_CURRENT_CORE()].stackIndex, TRC_SUCCESS)</td></tr>
<tr class="memdesc:ga00c946394372405d80af6ea398ccf18e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets current trace ISR nesting level.  <br /></td></tr>
<tr class="separator:ga00c946394372405d80af6ea398ccf18e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8b55f1af81e4016f931f45b855ac1804"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__isr__apis.html#ga8b55f1af81e4016f931f45b855ac1804">xTraceISRGetCurrentNestingReturned</a>()&#160;&#160;&#160;(pxTraceISRData-&gt;cores[TRC_CFG_GET_CURRENT_CORE()].stackIndex)</td></tr>
<tr class="separator:ga8b55f1af81e4016f931f45b855ac1804"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d7c34b68726a077b7914c3420a59834"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__isr__apis.html#ga5d7c34b68726a077b7914c3420a59834">xTraceISRGetCurrent</a>(pxISRHandle)&#160;&#160;&#160;(<a class="el" href="group__trace__isr__apis.html#ga8b55f1af81e4016f931f45b855ac1804">xTraceISRGetCurrentNestingReturned</a>() &gt;= 0 ? (*(pxISRHandle) = pxTraceISRData-&gt;cores[TRC_CFG_GET_CURRENT_CORE()].handleStack[<a class="el" href="group__trace__isr__apis.html#ga8b55f1af81e4016f931f45b855ac1804">xTraceISRGetCurrentNestingReturned</a>()], TRC_SUCCESS) : TRC_FAIL)</td></tr>
<tr class="memdesc:ga5d7c34b68726a077b7914c3420a59834"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets current trace ISR nesting level.  <br /></td></tr>
<tr class="separator:ga5d7c34b68726a077b7914c3420a59834"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga0ef382e6e5964c8db9b807434b931921"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__isr__apis.html#ga0ef382e6e5964c8db9b807434b931921">xTraceISRRegister</a> (const char *szName, uint32_t uiPriority, TraceISRHandle_t *pxISRHandle)</td></tr>
<tr class="memdesc:ga0ef382e6e5964c8db9b807434b931921"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers trace ISR.  <br /></td></tr>
<tr class="separator:ga0ef382e6e5964c8db9b807434b931921"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga28db1b1d4243e36cb68178af0387206a"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__isr__apis.html#ga28db1b1d4243e36cb68178af0387206a">xTraceISRBegin</a> (TraceISRHandle_t xISRHandle)</td></tr>
<tr class="memdesc:ga28db1b1d4243e36cb68178af0387206a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers the beginning of an Interrupt Service Routine.  <br /></td></tr>
<tr class="separator:ga28db1b1d4243e36cb68178af0387206a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga266d25f5ba9c184296268b44e8e3ce0a"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__isr__apis.html#ga266d25f5ba9c184296268b44e8e3ce0a">xTraceISREnd</a> (TraceBaseType_t xIsTaskSwitchRequired)</td></tr>
<tr class="memdesc:ga266d25f5ba9c184296268b44e8e3ce0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers the end of an Interrupt Service Routine.  <br /></td></tr>
<tr class="separator:ga266d25f5ba9c184296268b44e8e3ce0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga5d7c34b68726a077b7914c3420a59834" name="ga5d7c34b68726a077b7914c3420a59834"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d7c34b68726a077b7914c3420a59834">&#9670;&#160;</a></span>xTraceISRGetCurrent</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceISRGetCurrent</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">pxISRHandle</td><td>)</td>
          <td>&#160;&#160;&#160;(<a class="el" href="group__trace__isr__apis.html#ga8b55f1af81e4016f931f45b855ac1804">xTraceISRGetCurrentNestingReturned</a>() &gt;= 0 ? (*(pxISRHandle) = pxTraceISRData-&gt;cores[TRC_CFG_GET_CURRENT_CORE()].handleStack[<a class="el" href="group__trace__isr__apis.html#ga8b55f1af81e4016f931f45b855ac1804">xTraceISRGetCurrentNestingReturned</a>()], TRC_SUCCESS) : TRC_FAIL)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets current trace ISR nesting level. </p>
<p>This routine gets the current trace ISR nesting level for the CPU on which it is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">puiValue</td><td>Value.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga00c946394372405d80af6ea398ccf18e" name="ga00c946394372405d80af6ea398ccf18e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga00c946394372405d80af6ea398ccf18e">&#9670;&#160;</a></span>xTraceISRGetCurrentNesting</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceISRGetCurrentNesting</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">puiValue</td><td>)</td>
          <td>&#160;&#160;&#160;TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puiValue) = pxTraceISRData-&gt;cores[TRC_CFG_GET_CURRENT_CORE()].stackIndex, TRC_SUCCESS)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets current trace ISR nesting level. </p>
<p>This routine gets the current trace ISR nesting level for the CPU on which it is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">puiValue</td><td>Value.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga8b55f1af81e4016f931f45b855ac1804" name="ga8b55f1af81e4016f931f45b855ac1804"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8b55f1af81e4016f931f45b855ac1804">&#9670;&#160;</a></span>xTraceISRGetCurrentNestingReturned</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceISRGetCurrentNestingReturned</td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td>&#160;&#160;&#160;(pxTraceISRData-&gt;cores[TRC_CFG_GET_CURRENT_CORE()].stackIndex)</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>int32_t </dd></dl>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga28db1b1d4243e36cb68178af0387206a" name="ga28db1b1d4243e36cb68178af0387206a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga28db1b1d4243e36cb68178af0387206a">&#9670;&#160;</a></span>xTraceISRBegin()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceISRBegin </td>
          <td>(</td>
          <td class="paramtype">TraceISRHandle_t&#160;</td>
          <td class="paramname"><em>xISRHandle</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers the beginning of an Interrupt Service Routine. </p>
<p>This routine register the beginning of an ISR using a TraceISRHandle_t. See xTraceISRRegister for and example of using ISR tracing.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xISRHandle</td><td>Pointer to initialized ISR trace handle.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga266d25f5ba9c184296268b44e8e3ce0a" name="ga266d25f5ba9c184296268b44e8e3ce0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga266d25f5ba9c184296268b44e8e3ce0a">&#9670;&#160;</a></span>xTraceISREnd()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceISREnd </td>
          <td>(</td>
          <td class="paramtype">TraceBaseType_t&#160;</td>
          <td class="paramname"><em>xIsTaskSwitchRequired</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers the end of an Interrupt Service Routine. </p>
<p>This routine register the end of an ISR using a TraceISRHandle_t. See xTraceISRRegister for and example of using ISR tracing.</p>
<p>The parameter uxIsTaskSwitchRequired indicates if the interrupt has requested a task-switch (= 1), e.g., by signaling a semaphore. Otherwise (= 0) the interrupt is assumed to return to the previous context.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xIsTaskSwitchRequired</td><td>Task switch required.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga0ef382e6e5964c8db9b807434b931921" name="ga0ef382e6e5964c8db9b807434b931921"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ef382e6e5964c8db9b807434b931921">&#9670;&#160;</a></span>xTraceISRRegister()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceISRRegister </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>uiPriority</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceISRHandle_t *&#160;</td>
          <td class="paramname"><em>pxISRHandle</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers trace ISR. </p>
<p>This routine stores a name and priority level for an Interrupt Service Routine, to allow for better visualization. Returns a TraceISRHandle_t used by xTraceISRBegin/xTraceISREnd.</p>
<p>Example: #define PRIO_OF_ISR_TIMER1 3 // the hardware priority of the interrupt TraceISRHandle_t xISRTimer1Handle = 0; // The ID set by the recorder ... xTraceISRRegister("ISRTimer1", PRIO_OF_ISR_TIMER1, &amp;xISRTimer1Handle); ... void ISR_handler() { xTraceISRBegin(xISRTimer1Handle); ... xTraceISREnd(0); }</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiPriority</td><td>Priority. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxISRHandle</td><td>Pointer to uninitialized ISR trace handle.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
